<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: MsrpRequest.html 5 2014-12-10 22:27:01Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.msrp.msg;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.IOException;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.io.OutputStream;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.util.Arrays;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.util.regex.Pattern;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.dellroad.msrp.MsrpConstants;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>/**<a name="line.17"></a>
<span class="sourceLineNo">018</span> * MSRP request.<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>public class MsrpRequest extends MsrpMessage {<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>    private final String method;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>    private byte[] body;<a name="line.24"></a>
<span class="sourceLineNo">025</span>    private boolean complete = true;<a name="line.25"></a>
<span class="sourceLineNo">026</span>    private boolean aborted;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>    /**<a name="line.28"></a>
<span class="sourceLineNo">029</span>     * Construct an instance with no body and a random transaction ID.<a name="line.29"></a>
<span class="sourceLineNo">030</span>     *<a name="line.30"></a>
<span class="sourceLineNo">031</span>     * @param method request method<a name="line.31"></a>
<span class="sourceLineNo">032</span>     */<a name="line.32"></a>
<span class="sourceLineNo">033</span>    public MsrpRequest(String method) {<a name="line.33"></a>
<span class="sourceLineNo">034</span>        this(null, method, null);<a name="line.34"></a>
<span class="sourceLineNo">035</span>    }<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>    /**<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * Construct an instance with no body.<a name="line.38"></a>
<span class="sourceLineNo">039</span>     *<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * @param transactionId transaction ID, or null to have a randomly generated one assigned<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * @param method request method<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * @param headers MSRP headers, or null to have an empty instance created<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * @throws IllegalArgumentException if {@code method} is null<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * @throws IllegalArgumentException if {@code transactionId} is invalid<a name="line.44"></a>
<span class="sourceLineNo">045</span>     */<a name="line.45"></a>
<span class="sourceLineNo">046</span>    public MsrpRequest(String transactionId, String method, MsrpHeaders headers) {<a name="line.46"></a>
<span class="sourceLineNo">047</span>        this(transactionId, method, headers, null);<a name="line.47"></a>
<span class="sourceLineNo">048</span>    }<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>    /**<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * Construct an instance with a body.<a name="line.51"></a>
<span class="sourceLineNo">052</span>     *<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * @param transactionId transaction ID<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * @param method request method<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * @param headers MSRP headers, or null to have an empty instance created<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * @param body payload body, or null for none<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * @throws IllegalArgumentException if {@code method} is null or invalid<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * @throws IllegalArgumentException if {@code transactionId} is invalid<a name="line.58"></a>
<span class="sourceLineNo">059</span>     */<a name="line.59"></a>
<span class="sourceLineNo">060</span>    public MsrpRequest(String transactionId, String method, MsrpHeaders headers, byte[] body) {<a name="line.60"></a>
<span class="sourceLineNo">061</span>        super(transactionId, headers);<a name="line.61"></a>
<span class="sourceLineNo">062</span>        if (method == null)<a name="line.62"></a>
<span class="sourceLineNo">063</span>            throw new IllegalArgumentException("null method");<a name="line.63"></a>
<span class="sourceLineNo">064</span>        if (!Pattern.compile(Util.METHOD_REGEX).matcher(method).matches())<a name="line.64"></a>
<span class="sourceLineNo">065</span>            throw new IllegalArgumentException("invalid method `" + method + "'");<a name="line.65"></a>
<span class="sourceLineNo">066</span>        this.method = method;<a name="line.66"></a>
<span class="sourceLineNo">067</span>        this.body = body;<a name="line.67"></a>
<span class="sourceLineNo">068</span>    }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span>    /**<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * Get the MSRP request method associated with this instance.<a name="line.71"></a>
<span class="sourceLineNo">072</span>     */<a name="line.72"></a>
<span class="sourceLineNo">073</span>    public String getMethod() {<a name="line.73"></a>
<span class="sourceLineNo">074</span>        return this.method;<a name="line.74"></a>
<span class="sourceLineNo">075</span>    }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>    /**<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * Get the body payload associated with this instance, if any.<a name="line.78"></a>
<span class="sourceLineNo">079</span>     *<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @return body, or null if there is none<a name="line.80"></a>
<span class="sourceLineNo">081</span>     */<a name="line.81"></a>
<span class="sourceLineNo">082</span>    public byte[] getBody() {<a name="line.82"></a>
<span class="sourceLineNo">083</span>        return this.body;<a name="line.83"></a>
<span class="sourceLineNo">084</span>    }<a name="line.84"></a>
<span class="sourceLineNo">085</span>    public void setBody(byte[] body) {<a name="line.85"></a>
<span class="sourceLineNo">086</span>        this.body = body;<a name="line.86"></a>
<span class="sourceLineNo">087</span>    }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Get the whether this message body was flagged as complete.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * Default is true.<a name="line.91"></a>
<span class="sourceLineNo">092</span>     */<a name="line.92"></a>
<span class="sourceLineNo">093</span>    public boolean isComplete() {<a name="line.93"></a>
<span class="sourceLineNo">094</span>        return this.complete;<a name="line.94"></a>
<span class="sourceLineNo">095</span>    }<a name="line.95"></a>
<span class="sourceLineNo">096</span>    public void setComplete(boolean complete) {<a name="line.96"></a>
<span class="sourceLineNo">097</span>        this.complete = complete;<a name="line.97"></a>
<span class="sourceLineNo">098</span>    }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span>    /**<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * Get the whether this message body was flagged as aborted.<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * Default is false.<a name="line.102"></a>
<span class="sourceLineNo">103</span>     */<a name="line.103"></a>
<span class="sourceLineNo">104</span>    public boolean isAborted() {<a name="line.104"></a>
<span class="sourceLineNo">105</span>        return this.aborted;<a name="line.105"></a>
<span class="sourceLineNo">106</span>    }<a name="line.106"></a>
<span class="sourceLineNo">107</span>    public void setAborted(boolean aborted) {<a name="line.107"></a>
<span class="sourceLineNo">108</span>        this.aborted = aborted;<a name="line.108"></a>
<span class="sourceLineNo">109</span>    }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span>    /**<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * Build an {@link MsrpResponse} to this request, if appropriate, with the given error code and comment.<a name="line.112"></a>
<span class="sourceLineNo">113</span>     *<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * @param code three digit error code<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * @param comment error comment, or null<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * @return valid response, or null if this request should not generate any response (i.e., {@link FailureReport#NO}).<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * @throws IllegalArgumentException if {@code code} is not in the range 000 .. 999<a name="line.117"></a>
<span class="sourceLineNo">118</span>     */<a name="line.118"></a>
<span class="sourceLineNo">119</span>    public MsrpResponse buildResponse(int code, String comment) {<a name="line.119"></a>
<span class="sourceLineNo">120</span>        if (FailureReport.NO.equals(this.getHeaders().getFailureReport()))<a name="line.120"></a>
<span class="sourceLineNo">121</span>            return null;<a name="line.121"></a>
<span class="sourceLineNo">122</span>        final MsrpHeaders responseHeaders = new MsrpHeaders();<a name="line.122"></a>
<span class="sourceLineNo">123</span>        if (this.getMethod().equals(MsrpConstants.METHOD_SEND))<a name="line.123"></a>
<span class="sourceLineNo">124</span>            responseHeaders.getToPath().add(this.getHeaders().getFromPath().get(0));<a name="line.124"></a>
<span class="sourceLineNo">125</span>        else<a name="line.125"></a>
<span class="sourceLineNo">126</span>            responseHeaders.getToPath().addAll(this.getHeaders().getFromPath());<a name="line.126"></a>
<span class="sourceLineNo">127</span>        responseHeaders.getFromPath().add(this.getHeaders().getToPath().get(0));<a name="line.127"></a>
<span class="sourceLineNo">128</span>        return new MsrpResponse(this.getTransactionId(), code, comment, responseHeaders);<a name="line.128"></a>
<span class="sourceLineNo">129</span>    }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span>    /**<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * Determine if the given header name is a MIME header.<a name="line.132"></a>
<span class="sourceLineNo">133</span>     *<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * @throws IllegalArgumentException if {@code name} is null<a name="line.134"></a>
<span class="sourceLineNo">135</span>     */<a name="line.135"></a>
<span class="sourceLineNo">136</span>    public static boolean isMimeHeader(String name) {<a name="line.136"></a>
<span class="sourceLineNo">137</span>        if (name == null)<a name="line.137"></a>
<span class="sourceLineNo">138</span>            throw new IllegalArgumentException("null name");<a name="line.138"></a>
<span class="sourceLineNo">139</span>        final String prefix = MsrpConstants.MIME_CONTENT_HEADER_PREFIX;<a name="line.139"></a>
<span class="sourceLineNo">140</span>        return name.regionMatches(true, 0, prefix, 0, prefix.length());<a name="line.140"></a>
<span class="sourceLineNo">141</span>    }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span>// Object<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>    @Override<a name="line.145"></a>
<span class="sourceLineNo">146</span>    public boolean equals(Object obj) {<a name="line.146"></a>
<span class="sourceLineNo">147</span>        if (obj == this)<a name="line.147"></a>
<span class="sourceLineNo">148</span>            return true;<a name="line.148"></a>
<span class="sourceLineNo">149</span>        if (!super.equals(obj))<a name="line.149"></a>
<span class="sourceLineNo">150</span>            return false;<a name="line.150"></a>
<span class="sourceLineNo">151</span>        final MsrpRequest that = (MsrpRequest)obj;<a name="line.151"></a>
<span class="sourceLineNo">152</span>        if (!this.method.equals(that.method))<a name="line.152"></a>
<span class="sourceLineNo">153</span>            return false;<a name="line.153"></a>
<span class="sourceLineNo">154</span>        if (!(this.body != null ? that.body != null &amp;&amp; Arrays.equals(this.body, that.body) : that.body == null))<a name="line.154"></a>
<span class="sourceLineNo">155</span>            return false;<a name="line.155"></a>
<span class="sourceLineNo">156</span>        if (this.complete != that.complete)<a name="line.156"></a>
<span class="sourceLineNo">157</span>            return false;<a name="line.157"></a>
<span class="sourceLineNo">158</span>        if (this.aborted != that.aborted)<a name="line.158"></a>
<span class="sourceLineNo">159</span>            return false;<a name="line.159"></a>
<span class="sourceLineNo">160</span>        return true;<a name="line.160"></a>
<span class="sourceLineNo">161</span>    }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span>    @Override<a name="line.163"></a>
<span class="sourceLineNo">164</span>    public int hashCode() {<a name="line.164"></a>
<span class="sourceLineNo">165</span>        return super.hashCode()<a name="line.165"></a>
<span class="sourceLineNo">166</span>          ^ this.method.hashCode()<a name="line.166"></a>
<span class="sourceLineNo">167</span>          ^ (this.body != null ? Arrays.hashCode(this.body) : 0)<a name="line.167"></a>
<span class="sourceLineNo">168</span>          ^ (this.complete ? 1 : 0)<a name="line.168"></a>
<span class="sourceLineNo">169</span>          ^ (this.aborted ? 2 : 0);<a name="line.169"></a>
<span class="sourceLineNo">170</span>    }<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span>// Subclass overrides<a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>
<span class="sourceLineNo">174</span>    @Override<a name="line.174"></a>
<span class="sourceLineNo">175</span>    public byte getFlagByte() {<a name="line.175"></a>
<span class="sourceLineNo">176</span>        return this.aborted ? MsrpConstants.FLAG_ABORT :<a name="line.176"></a>
<span class="sourceLineNo">177</span>          this.complete ? MsrpConstants.FLAG_COMPLETE : MsrpConstants.FLAG_INCOMPLETE;<a name="line.177"></a>
<span class="sourceLineNo">178</span>    }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span>    @Override<a name="line.180"></a>
<span class="sourceLineNo">181</span>    protected String getFirstLine() {<a name="line.181"></a>
<span class="sourceLineNo">182</span>        return "MSRP " + this.getTransactionId() + " " + this.method;<a name="line.182"></a>
<span class="sourceLineNo">183</span>    }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span>    @Override<a name="line.185"></a>
<span class="sourceLineNo">186</span>    protected void writePayload(OutputStream output) throws IOException {<a name="line.186"></a>
<span class="sourceLineNo">187</span>        if (this.body != null) {<a name="line.187"></a>
<span class="sourceLineNo">188</span>            output.write('\r');<a name="line.188"></a>
<span class="sourceLineNo">189</span>            output.write('\n');<a name="line.189"></a>
<span class="sourceLineNo">190</span>            output.write(this.body);<a name="line.190"></a>
<span class="sourceLineNo">191</span>            output.write('\r');<a name="line.191"></a>
<span class="sourceLineNo">192</span>            output.write('\n');<a name="line.192"></a>
<span class="sourceLineNo">193</span>        }<a name="line.193"></a>
<span class="sourceLineNo">194</span>    }<a name="line.194"></a>
<span class="sourceLineNo">195</span>}<a name="line.195"></a>
<span class="sourceLineNo">196</span><a name="line.196"></a>




























































</pre>
</div>
</body>
</html>
